CuDoubleSidedScannerAPI  1.11
Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters Class Reference

Class that stores the scan parameters to be used during the scan job. More...

Public Types

enum  ScanSideValue : byte
 Indicates the scan side. More...
 
enum  GammaChannelValue : byte
 Indicates the Gamma Channel. More...
 
enum  ImageResolution : uint
 Output image resolution More...
 
enum  ImageFileFormat
 Output image file format More...
 
enum  ColorChannel
 Scan color channel More...
 
enum  DoubleSheetDetectOpt : uint
 Ultrasonic sensor settings for double/multiple sheet loaded detection. More...
 
enum  PaperHeldBackDetectionOpt : uint
 Setting for paper held back detection More...
 

Public Member Functions

 CuScanParameters ()
 Creates a new CuScanParameters object. More...
 
void Init ()
 Sets default values.
More...
 

Public Attributes

CuScanner.ScannerEjectType TicketAfterScanMovement
 Select the behaviour of the paper sheet after scan. Select whether to return backward to the user, or to push it over the scanner, or to keep it hold, waiting for a later backward or forward movement command. More...
 
ColorChannel ScanColorChannel
 Select the scan color channel. The color of the channel will be filtered by the scan, and will be not visible on the scanned image. More...
 
Boolean HardwareDeskewing
 True by default, allows to use the scanner hardware deskewing (advised). Set to false to disable hardware deskewing (only for specific application). More...
 
DoubleSheetDetectOpt DoubleSheetDetection
 
PaperHeldBackDetectionOpt PaperHeldBackDetection
 Enabled by default, allows to determine whether to stop the scan job if the user holds bak the paper, or not. Set to PaperHeldBackDetectionOpt.Off to disable the detection of "paper held back" jam (only for specific application). Set Advised value: PaperHeldBackDetectionOpt.On. Only for ScannerType.A6 More...
 
int Brightness
 Indicates a value for brightness. Default value is 0. The brightness can be both positive (brighter image) or negative (darker image). The minimum value is -20, the maximum value is +30. For values out of range, the default value will be set. Only for ScannerCapability.ScannerType.A4 More...
 
byte NumRetryMovementBeforeStartScan
 Indicates the number of movement to do before start the scan. Default value is 0. More...
 

Properties

PixelFormat ImageColorDepth [get, set]
 Output image color depth, in System.Drawing.Imaging.PixelFormat
More...
 
ScanSideValue ScanSide [get, set]
 Specifies the scan side: A (up), B(down), or A+B (up+down) More...
 
ImageResolution Resolution [get, set]
 Output image resolution, in dpi More...
 
ImageFileFormat ImageOutFormat [get, set]
 Output image file format More...
 
bool CropDeskew [get, set]
 If true, acquired image is elaborated by crop and deskewing operations. This parameter is used only when ImageFormat.JPG has been selected. More...
 
uint JpgQuality [get, set]
 Image quality. Used only when ImageFormat.JPG has been selected. Allowed values from 1 (minimum) to 100 (maximum). More...
 

Detailed Description

Class that stores the scan parameters to be used during the scan job.

Member Enumeration Documentation

◆ ColorChannel

Scan color channel

Enumerator
Red_channel 

Scan by red channel.

Green_channel 

Scan by green channel.

Blue_channel 

Scan by blue channel.

White_channel 

Scan by white channel (all channels)

◆ DoubleSheetDetectOpt

Ultrasonic sensor settings for double/multiple sheet loaded detection.

Enumerator
Off 

Turn OFF the double/multiple sheet detection.

LevelA 

Turn ON the double/multiple sheet detection, using VERY HIGH sensor sensitivity.

LevelB 

Turn ON the double/multiple sheet detection, using HIGH sensor sensitivity (Only supported by ScannerCapability.ScannerType.A4)

LevelC 

Turn ON the double/multiple sheet detection, using LOW sensor sensitivity (Only supported by ScannerCapability.ScannerType.A4)

LevelD 

Turn ON the double/multiple sheet detection, using VERY LOW sensor sensitivity (Only supported by ScannerCapability.ScannerType.A4)

◆ GammaChannelValue

Indicates the Gamma Channel.

Enumerator
CHANNEL_RED 

Indicates the colorchannel RED

CHANNEL_GREEN 

Indicates the colorchannel GREEN

CHANNEL_BLUE 

Indicates the colorchannel BLUE

◆ ImageFileFormat

Output image file format

Enumerator
BMP 

Image from the scanner is a BMP.

JPG 

Image from the scanner is a JPEG.

TIFF 

Image from the scanner is a TIFF without compression.

RAW 

Image from the scanner is a RAW file. The image will be saved from up-left to down-right. For 1 bpp, value 0 means black, value 1 means white; for 8 bpp data is a grey scale starting from 0 (black) to 255 (white); for 24 bpp data is saved in RGB.

JPG_NATIVE 

Native Jpeg image. Only supported by ScannerCapability.ScannerType.A4.

TIFF_COMP_RLE 

Image from the scanner is a TIFF with RLE compression.

TIFF_COMP_LZW 

Image from the scanner is a TIFF with LZW compression.

TIFF_COMP_CCITT4 

Image from the scanner is a TIFF with CCITT4 compression.

Warning
This compression only creates black and white (1 bpp) images. Scan will be forced to be 1 bpp
TIFF_COMP_CCITT3 

Image from the scanner is a TIFF with CCITT3 compression.

Warning
This compression only creates black and white (1 bpp) images. Scan will be forced to be 1 bpp
PNG 

Image from the scanner is a PNG.

◆ ImageResolution

Output image resolution

Enumerator
RESOLUTION_100_DPI 

100 dpi resolution

RESOLUTION_150_DPI 

150 dpi resolution

RESOLUTION_200_DPI 

200 dpi resolution

RESOLUTION_250_DPI 

250 dpi resolution

RESOLUTION_300_DPI 

300 dpi resolution

RESOLUTION_600_DPI 

600 dpi resolution

◆ PaperHeldBackDetectionOpt

Setting for paper held back detection

Enumerator
Off 

Turn OFF the paper held back detection (not advised)

On 

Turn ON the paper held back detection (advised)

◆ ScanSideValue

Indicates the scan side.

Enumerator
SIDE_A 

Indicates only A side (up side) will be scanned

SIDE_B 

Indicates only B side (down side) will be scanned

SIDE_A_AND_B 

Indicates both A and B side (up and down side) will be scanned

Constructor & Destructor Documentation

◆ CuScanParameters()

Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.CuScanParameters ( )
inline

Creates a new CuScanParameters object.

See also
Init() to know the default values.

Member Function Documentation

◆ Init()

Member Data Documentation

◆ Brightness

int Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.Brightness

Indicates a value for brightness. Default value is 0. The brightness can be both positive (brighter image) or negative (darker image). The minimum value is -20, the maximum value is +30. For values out of range, the default value will be set. Only for ScannerCapability.ScannerType.A4

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.Init().

◆ DoubleSheetDetection

DoubleSheetDetectOpt Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.DoubleSheetDetection

Enabled by default, allows to determine if double or multiple sheets have been loaded (advised). Set to DoubleSheetDetectOpt.Off to disable the detection of double/multiple sheet loading (only for specific application).

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.Init().

◆ HardwareDeskewing

Boolean Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.HardwareDeskewing

True by default, allows to use the scanner hardware deskewing (advised). Set to false to disable hardware deskewing (only for specific application).

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.Init().

◆ NumRetryMovementBeforeStartScan

byte Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.NumRetryMovementBeforeStartScan

Indicates the number of movement to do before start the scan. Default value is 0.

Only for ScannerCapability.ScannerType.A6

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.Init().

◆ PaperHeldBackDetection

PaperHeldBackDetectionOpt Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.PaperHeldBackDetection

Enabled by default, allows to determine whether to stop the scan job if the user holds bak the paper, or not. Set to PaperHeldBackDetectionOpt.Off to disable the detection of "paper held back" jam (only for specific application). Set Advised value: PaperHeldBackDetectionOpt.On. Only for ScannerType.A6

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.Init().

◆ ScanColorChannel

ColorChannel Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.ScanColorChannel

Select the scan color channel. The color of the channel will be filtered by the scan, and will be not visible on the scanned image.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.Init().

◆ TicketAfterScanMovement

CuScanner.ScannerEjectType Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.TicketAfterScanMovement

Select the behaviour of the paper sheet after scan. Select whether to return backward to the user, or to push it over the scanner, or to keep it hold, waiting for a later backward or forward movement command.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.Init().

Property Documentation

◆ CropDeskew

bool Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.CropDeskew
getset

If true, acquired image is elaborated by crop and deskewing operations. This parameter is used only when ImageFormat.JPG has been selected.

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.Init().

◆ ImageColorDepth

PixelFormat Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.ImageColorDepth
getset

Output image color depth, in System.Drawing.Imaging.PixelFormat

Note
Supported values: PixelFormat.Format8bppIndexed (8 bit gray scale) and PixelFormat.Format24bppRgb (24 bit color).

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.Init().

◆ ImageOutFormat

ImageFileFormat Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.ImageOutFormat
getset

Output image file format

◆ JpgQuality

uint Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.JpgQuality
getset

Image quality. Used only when ImageFormat.JPG has been selected. Allowed values from 1 (minimum) to 100 (maximum).

◆ Resolution

ImageResolution Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.Resolution
getset

Output image resolution, in dpi

Referenced by Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.Init().

◆ ScanSide

ScanSideValue Custom.CuDoubleSidedScannerAPIWrap.CuScanParameters.ScanSide
getset

Specifies the scan side: A (up), B(down), or A+B (up+down)